| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

MapRequestDescriptor.h
1 // MapRequestDescriptor.h
3 //
5
6 namespace nkGraphics
7 {
11 struct BufferSubResourceDescriptor
12 {
13 unsigned int _subResourceIndex = 0 ;
14 } ;
15
19 struct TextureSubResourceDescriptor
20 {
21 unsigned int _indexInArray = 0 ;
22 unsigned int _mipIndex = 0 ;
23 } ;
24
28 struct MapRequestDescriptor
29 {
30 // Attributes
31 MAP _mapType = MAP_WRITE_DISCARD ;
32
33 union
34 {
35 BufferSubResourceDescriptor _buffer ;
36 TextureSubResourceDescriptor _texture = TextureSubResourceDescriptor() ;
37 } ;
38
39 // Constructors
43 MapRequestDescriptor () = default ;
50 MapRequestDescriptor (MAP mapType, unsigned int bufferSubResourceIndex) ;
58 MapRequestDescriptor (MAP mapType, unsigned int textureIndexInArray, unsigned int textureMipIndex) ;
59 } ;
60 }
nkGraphics::MapRequestDescriptor
A description of a request to map a resource.
Definition: MapRequestDescriptor.h:29
nkGraphics::MapRequestDescriptor::_texture
TextureSubResourceDescriptor _texture
If the request is made to map a texture, this member should be populated.
Definition: MapRequestDescriptor.h:36
nkGraphics::TextureSubResourceDescriptor
Describes how a texture should be mapped.
Definition: MapRequestDescriptor.h:20
nkGraphics::MapRequestDescriptor::MapRequestDescriptor
MapRequestDescriptor(MAP mapType, unsigned int bufferSubResourceIndex)
nkGraphics::TextureSubResourceDescriptor::_indexInArray
unsigned int _indexInArray
For texture arrays, the index within the array of the texture to map.
Definition: MapRequestDescriptor.h:21
nkGraphics::BufferSubResourceDescriptor
Describes how a buffer should be mapped.
Definition: MapRequestDescriptor.h:12
nkGraphics::TextureSubResourceDescriptor::_mipIndex
unsigned int _mipIndex
If the texture has mips, which mip index should be mapped.
Definition: MapRequestDescriptor.h:22
nkGraphics::BufferSubResourceDescriptor::_subResourceIndex
unsigned int _subResourceIndex
The sub-resource to map within the buffer.
Definition: MapRequestDescriptor.h:13
nkGraphics::MapRequestDescriptor::_mapType
MAP _mapType
The map type requested.
Definition: MapRequestDescriptor.h:31
nkGraphics::MAP
MAP
Available mapping request types.
Definition: DxDefinesWrapper.h:111
nkGraphics::MapRequestDescriptor::_buffer
BufferSubResourceDescriptor _buffer
If the request is made to map a buffer, this member should be populated.
Definition: MapRequestDescriptor.h:35
nkGraphics::MapRequestDescriptor::MapRequestDescriptor
MapRequestDescriptor()=default
nkGraphics::MapRequestDescriptor::MapRequestDescriptor
MapRequestDescriptor(MAP mapType, unsigned int textureIndexInArray, unsigned int textureMipIndex)
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7